org.eclipse.vtp.framework.engine.runtime
Class Sequence.Context

java.lang.Object
  org.eclipse.vtp.framework.engine.support.AbstractReporter
      org.eclipse.vtp.framework.engine.support.AbstractLogger
          org.eclipse.vtp.framework.engine.support.AbstractContext
              org.eclipse.vtp.framework.engine.support.AbstractActionContext
                  org.eclipse.vtp.framework.engine.runtime.Sequence.Context

All Implemented Interfaces:

IActionContext, IContext, IExecutionContext, ILogger, IProcessContext, IReporter, ISessionContext

Enclosing class:

Sequence

protected final class Sequence.Context
extends AbstractActionContext

Implementation of the generic context.

Author:

Lonnie Pryor

Field Summary

Fields inherited from class org.eclipse.vtp.framework.engine.support.AbstractActionContext

executionContext, RESERVED_SERVICE_IDENTIFIERS

Fields inherited from interface org.eclipse.vtp.framework.core.IActionContext

STATE_AFTER, STATE_BEFORE, STATE_DURING

Fields inherited from interface org.eclipse.vtp.framework.core.IReporter

SEVERITY_DEBUG, SEVERITY_ERROR, SEVERITY_INFO, SEVERITY_WARN

Method Summary

IActionResult	createResult(java.lang.String resultName, java.lang.Throwable failureCause) Creates an action result with the specified name.
java.lang.String	getActionID() Returns the ID of the current action.
java.lang.String	getActionName() Returns the name of the current action.
int	getActionState() Returns the state of the current action.
protected java.lang.Object[]	lookupAllLocalServices(java.lang.String identifier) Returns all the services registered under the specified identifier in this registry or null if no such services can be found.
protected java.lang.Object	lookupLocalService(java.lang.String identifier) Returns a service registered under the specified identifier in this registry or null if no such service exists.

Methods inherited from class org.eclipse.vtp.framework.engine.support.AbstractActionContext

clearAttribute, clearParameter, createResult, doReport, getAttribute, getAttributeNames, getExecutionID, getParameter, getParameterNames, getParameters, getProcessID, getProperty, getSessionID, isSeverityEnabled, loadClass, lookupAllInheritedServices, lookupInheritedService, lookupReservedService, setAttribute, setParameter, setParameters

Methods inherited from class org.eclipse.vtp.framework.engine.support.AbstractContext

lookup, lookupAll

Methods inherited from class org.eclipse.vtp.framework.engine.support.AbstractLogger

debug, debug, debug, debug, doLog, error, error, error, error, info, info, info, info, isDebugEnabled, isErrorEnabled, isInfoEnabled, isWarnEnabled, log, log, log, log, warn, warn, warn, warn

Methods inherited from class org.eclipse.vtp.framework.engine.support.AbstractReporter

report, report, report, report

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.vtp.framework.core.IContext

lookup, lookupAll

Methods inherited from interface org.eclipse.vtp.framework.core.ILogger

debug, debug, debug, debug, error, error, error, error, info, info, info, info, isDebugEnabled, isErrorEnabled, isInfoEnabled, isWarnEnabled, log, log, log, log, warn, warn, warn, warn

Methods inherited from interface org.eclipse.vtp.framework.core.IReporter

report, report, report, report

Method Detail

lookupLocalService

protected java.lang.Object lookupLocalService(java.lang.String identifier)

Description copied from class: AbstractContext

Returns a service registered under the specified identifier in this registry or null if no such service exists.

Overrides:

lookupLocalService in class AbstractContext

Parameters:

identifier - The identifier of the service to return, will never be null.

Returns:

A service registered under the specified identifier in this registry or null if no such service exists.

lookupAllLocalServices

protected java.lang.Object[] lookupAllLocalServices(java.lang.String identifier)

Description copied from class: AbstractContext

Returns all the services registered under the specified identifier in this registry or null if no such services can be found.

Overrides:

lookupAllLocalServices in class AbstractContext

Parameters:

identifier - The identifier of the services to return, will never be null.

Returns:

All the services registered under the specified identifier in this registry or null if no such services can be found.

getActionID

public java.lang.String getActionID()

Description copied from interface: IActionContext

Returns the ID of the current action.

Returns:

The ID of the current action.

getActionName

public java.lang.String getActionName()

Description copied from interface: IActionContext

Returns the name of the current action.

Returns:

The name of the current action.

getActionState

public int getActionState()

Description copied from interface: IActionContext

Returns the state of the current action.

Returns:

The state of the current action.

createResult

public IActionResult createResult(java.lang.String resultName,
                                  java.lang.Throwable failureCause)

Description copied from interface: IActionContext

Creates an action result with the specified name.

Parameters:

resultName - The name of the result to create or null to create an undefined result.

failureCause - The cause of the failure the action result represents or null to not specify a failure cause.

Returns:

A new action result with the specified name and failure cause.